Skip to content

docs(misc): rewrite turborepo migration guide as step-by-step - #36594

Open
jaysoo wants to merge 5 commits into
masterfrom
DOC-571
Open

docs(misc): rewrite turborepo migration guide as step-by-step#36594
jaysoo wants to merge 5 commits into
masterfrom
DOC-571

Conversation

@jaysoo

@jaysoo jaysoo commented Aug 6, 2026

Copy link
Copy Markdown
Member

Current Behavior

The Turborepo migration page was a config and command mapping table with a single nx init example, and it documented nx init output that never existed (dev comes out as { "cache": false }, not { "continuous": true }).

Expected Behavior

Eight numbered steps with an AI prompt card, covering what nx init does not convert. Moved to /docs/kb/from-turborepo and featured, with a redirect. Steps and prompt were validated by running the copy-prompt end to end against three generated Turborepo fixtures.

Preview: https://deploy-preview-36594--nx-docs.netlify.app/docs/kb/from-turborepo

Related Issue(s)

DOC-571


Polygraph View session ↗

@netlify

netlify Bot commented Aug 6, 2026

Copy link
Copy Markdown

Deploy Preview for nx-docs ready!

Name Link
🔨 Latest commit 56f7424
🔍 Latest deploy log https://app.netlify.com/projects/nx-docs/deploys/6a760fdea9a8a139f9c0272d
😎 Deploy Preview https://deploy-preview-36594--nx-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Aug 6, 2026

Copy link
Copy Markdown

Deploy Preview for nx-dev ready!

Name Link
🔨 Latest commit 56f7424
🔍 Latest deploy log https://app.netlify.com/projects/nx-dev/deploys/6a75f30ee295530009ba769f
😎 Deploy Preview https://deploy-preview-36594--nx-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@jaysoo
jaysoo marked this pull request as ready for review August 6, 2026 20:09
@jaysoo
jaysoo requested a review from a team as a code owner August 6, 2026 20:09
@jaysoo
jaysoo requested a review from leosvelperez August 6, 2026 20:09
Comment thread astro-docs/src/content/docs/kb/from-turborepo.mdoc Outdated
Comment thread astro-docs/src/content/docs/kb/from-turborepo.mdoc Outdated
Comment thread astro-docs/src/content/docs/kb/from-turborepo.mdoc Outdated
Comment thread astro-docs/src/content/docs/kb/from-turborepo.mdoc Outdated
Comment thread astro-docs/src/content/docs/kb/from-turborepo.mdoc
@nx-cloud

nx-cloud Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

View your CI Pipeline Execution ↗ for commit 56f7424

Command Status Duration Result
nx affected --targets=lint,test,build,e2e,e2e-c... ✅ Succeeded 9m 11s View ↗
nx run-many -t check-imports check-lock-files c... ✅ Succeeded 7s View ↗
nx-cloud record -- pnpm nx-cloud conformance:check ✅ Succeeded 1m View ↗
nx build workspace-plugin ✅ Succeeded <1s View ↗
nx-cloud record -- nx sync:check ✅ Succeeded 17s View ↗
nx-cloud record -- nx format:check ✅ Succeeded 5s View ↗

☁️ Nx Cloud last updated this comment at 2026-08-07 16:35:42 UTC

@jaysoo
jaysoo enabled auto-merge (squash) August 7, 2026 00:57
@jaysoo
jaysoo disabled auto-merge August 7, 2026 01:05
jaysoo added 5 commits August 7, 2026 10:56
Page sat under Adopting Nx as a config/command mapping table with one
"run nx init" example. Claimed nx init output was wrong: `dev` gets
`{ "cache": false }`, not `{ "continuous": true }` - the converter drops
`persistent`.

Moved to the knowledge base at /docs/kb/from-turborepo (redirect added) and
featured; "Nx and Angular Versions" unfeatured to make room.

8 numbered steps + AI prompt card at top. Covers what `nx init` does not
convert: `<package>#<task>` fragments, per-package turbo.json, `persistent`,
task-level `env`, top-level keys like `ui`. Fragments map to the
`targetDefaults` array form with `filter.projects`. Mapping tables demoted to
additional considerations.

Steps and prompt validated by running the copy-prompt end to end against three
generated turborepo fixtures. Fixes found that way:

- `sharedGlobals` caveat. `nx init` reaches it via `default`, so any target
  with an explicit `inputs` array bypasses it and `globalEnv` /
  `globalDependencies` stop invalidating that target.
- Filtered `targetDefaults` entries replace baseline values per key, arrays
  included, so filtered `inputs` must re-list the baseline.
- Per-package turbo.json now has a stated port path, not just a delete step.
- Directory patterns over name globs for shared rules; tags are set in project
  config, which the page never said.
- Cleanup sweeps the whole workspace, not just root scripts - `turbo gen` in a
  package and `eslint-plugin-turbo` both survived a literal pass.

DOC-571
## Current Behavior

Intro paragraph forward-referenced step numbers and read as part of the AI
prompt card. Merge-semantics prose in step 3 was dense. Cleanup sweep was
unix-only. Wording implied Nx suits large workspaces and turbo small ones.

## Expected Behavior

Intro trimmed to one paragraph. Step 3 resolution rules cut to two bullets
plus a link to the target defaults reference. grep sweep gets a PowerShell
tab. CI section reframed around what a cache cannot help with.

Also applied the updated STYLE_GUIDE anti-AI rules: dropped significance
clauses and reverse drama beats. 99 words shorter.

## Related Issue(s)

DOC-571
## Current Behavior

Step 3 spent a paragraph and two bullets on override resolution, repeated the
array explanation on both sides of the code block, and carried a second code
block that differed by one line. sharedGlobals aside showed the target
inputs without the namedInputs block it refers to.

## Expected Behavior

One sentence for the array shape, one for the override rule, rest to the
reference. Second code block folded into prose. sharedGlobals aside shows the
namedInputs entry alongside the target.

## Related Issue(s)

DOC-571
## Current Behavior

Paragraphs opened with a short label sentence ("CI is the other gap.",
"Two smaller differences.", "Nx uses the flag for more than bookkeeping.")
before the content that carried the actual claim.

## Expected Behavior

Labels removed or folded into the sentence that follows. Content unchanged.

## Related Issue(s)

DOC-571
## Current Behavior

A paragraph that opens with a short label sentence passes the drama-beat
test, because the sentences after it do add facts. Nothing else covers it.

## Expected Behavior

New "Cut signpost openers" rule, plus a first-sentence read in the
pre-publish pass order.

## Related Issue(s)

DOC-571
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants